api_request Element

Description

Starts a connection request.

Namespace

(none)

Diagram

Overview

api_request

Starts a connection request.

Sequence

action xs:string

One of nine action types. This lets us know the type of connection you wish to make and what you need the API to do for you. In the case of requesting a report based on a campaign id, the action type is "report".

username xs:string

The username of this user as stored on the PRODOCOM system. You will need to get this information from PRODOCOM before you attempt any form of API connection. Typically the username is PRODOCOM website login.

password xs:string

The password of this user as stored on the PRODOCOM system, You will need to get this information from PRODOCOM before you attempt any form of API connection.

campaign_id xs:string

This is the PRODOCOM system ID for a campaign. This ID will have been retrieved when using a "campaignlist" action request.

msg_id xs:string

This is the PRODOCOM system ID for a message within a campaign. A campaign may contain many messages each with many destinations.

includecustom xs:string

This is an optional field if you wish the request to return all additional custom fields in the recipient details.

Source

<xs:element name="api_request" xmlns:xs="http://www.w3.org/2001/XMLSchema">
  <xs:complexType>
    <xs:sequence>
      <xs:element type="xs:string" name="action" />
      <xs:element type="xs:string" name="username" />
      <xs:element type="xs:string" name="password" />
      <xs:element type="xs:string" name="campaign_id" />
      <xs:element type="xs:string" name="msg_id" />
      <xs:element type="xs:string" name="includecustom" />
    </xs:sequence>
  </xs:complexType>
</xs:element>